Fix broken web components links in Admin API descriptions (2026-01)#4539
Merged
Conversation
Admin component JSDoc linked to the old `using-web-components` slug (both `polaris/` and `app-ui/` prefixes). `polaris/using-web-components` 404s, and `app-ui/using-web-components` 301-redirects to the canonical page while dropping the URL `#fragment` — so links like SpacingKeyword (#scale) and responsive value (#responsive-values) either 404d or landed at the top of the page instead of the section. Restore the canonical slug everywhere: (polaris|app-ui)/using-web-components -> polaris/using-polaris-web-components Links-only diff. Updates source .d.ts files and checked-in v2 docs data. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
We detected some changes in |
This was referenced Jul 1, 2026
sordaz00
changed the title
chadwcarlson
approved these changes
Jul 1, 2026
sordaz00
changed the title
gwyneplaine
approved these changes
Jul 2, 2026
mikeygough
approved these changes
Jul 2, 2026
laurkim
approved these changes
Jul 2, 2026
kyledurand
approved these changes
Jul 2, 2026
alex-page
pushed a commit
that referenced
this pull request
Jul 6, 2026
## Problem **These links were broken.** Admin component JSDoc linked to the old `using-web-components` slug, which no longer resolves correctly. There were two failure modes, both live on production: | Link in source | HTTP | Result | |---|---|---| | `/docs/api/polaris/using-web-components#…` (most links) | **404** | Page not found — hard broken | | `/docs/api/app-ui/using-web-components#…` | **301** | Redirects to the canonical page but **drops the `#fragment`**, landing at the top instead of the section | | `/docs/api/polaris/using-polaris-web-components#…` | **200** | Correct — anchors resolve ✓ | So links such as `SpacingKeyword` (`#scale`) and responsive value (`#responsive-values`) either 404’d outright or dumped the reader at the top of the page instead of the intended section. ## Fix Restore the canonical slug everywhere in the admin surface: ``` (polaris|app-ui)/using-web-components -> polaris/using-polaris-web-components ``` Links-only diff (no content/symbol changes). Touches the source `.d.ts` files and the checked-in v2 docs data. 🤖 Generated with [Claude Code](https://claude.com/claude-code) _Part of a set fixing this across all affected versions: #4538 (2025-10), #4539 (2026-01), #4537 (2026-04), #4536 (2026-07-rc)._
sordaz00
added a commit
that referenced
this pull request
Jul 6, 2026
## Problem **These links were broken.** Admin component JSDoc linked to the old `using-web-components` slug, which no longer resolves correctly. There were two failure modes, both live on production: | Link in source | HTTP | Result | |---|---|---| | `/docs/api/polaris/using-web-components#…` (most links) | **404** | Page not found — hard broken | | `/docs/api/app-ui/using-web-components#…` | **301** | Redirects to the canonical page but **drops the `#fragment`**, landing at the top instead of the section | | `/docs/api/polaris/using-polaris-web-components#…` | **200** | Correct — anchors resolve ✓ | So links such as `SpacingKeyword` (`#scale`) and responsive value (`#responsive-values`) either 404’d outright or dumped the reader at the top of the page instead of the intended section. ## Fix Restore the canonical slug everywhere in the admin surface: ``` (polaris|app-ui)/using-web-components -> polaris/using-polaris-web-components ``` Links-only diff (no content/symbol changes). Touches the source `.d.ts` files and the checked-in v2 docs data. 🤖 Generated with [Claude Code](https://claude.com/claude-code) _Part of a set fixing this across all affected versions: #4538 (2025-10), #4539 (2026-01), #4537 (2026-04), #4536 (2026-07-rc)._
sordaz00
added a commit
that referenced
this pull request
Jul 6, 2026
…4538) ## Problem **These links were broken.** Admin component JSDoc linked to the old `using-web-components` slug, which no longer resolves correctly. There were two failure modes, both live on production: | Link in source | HTTP | Result | |---|---|---| | `/docs/api/polaris/using-web-components#…` (most links) | **404** | Page not found — hard broken | | `/docs/api/app-ui/using-web-components#…` | **301** | Redirects to the canonical page but **drops the `#fragment`**, landing at the top instead of the section | | `/docs/api/polaris/using-polaris-web-components#…` | **200** | Correct — anchors resolve ✓ | So links such as `SpacingKeyword` (`#scale`) and responsive value (`#responsive-values`) either 404’d outright or dumped the reader at the top of the page instead of the intended section. ## Fix Restore the canonical slug everywhere in the admin surface: ``` (polaris|app-ui)/using-web-components -> polaris/using-polaris-web-components ``` Links-only diff (no content/symbol changes). Touches the source `.d.ts` files and the checked-in v2 docs data. 🤖 Generated with [Claude Code](https://claude.com/claude-code) _Part of a set fixing this across all affected versions: #4538 (2025-10), #4539 (2026-01), #4537 (2026-04), #4536 (2026-07-rc)._
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
These links were broken. Admin component JSDoc linked to the old
using-web-componentsslug, which no longer resolves correctly. There were two failure modes, both live on production:/docs/api/polaris/using-web-components#…(most links)/docs/api/app-ui/using-web-components#…#fragment, landing at the top instead of the section/docs/api/polaris/using-polaris-web-components#…So links such as
SpacingKeyword(#scale) and responsive value (#responsive-values) either 404’d outright or dumped the reader at the top of the page instead of the intended section.Fix
Restore the canonical slug everywhere in the admin surface:
Links-only diff (no content/symbol changes). Touches the source
.d.tsfiles and the checked-in v2 docs data.🤖 Generated with Claude Code
Part of a set fixing this across all affected versions: #4538 (2025-10), #4539 (2026-01), #4537 (2026-04), #4536 (2026-07-rc).